cPy.cCore module

Expand for references to cPy.cCore

Mouse and Cursor Extension Example / Debugging and Editing

class BaseClass

Bases: object

Use this class for build a class for UI or serialization.

see class_reg.h for details about the class registration

GetClassMask() → int

Masking elements of class. Each member has mask. Element is serializable/visible only if (it’s_mask & hosting_class_mask) != 0

ClassMask() → int

runFunction(func: any)

reset_class(DataPtr: any = None)

CopyBaseClass(Dest: BaseClass, Add: bool = False) → bool

Copy base class to other class uning names correspondence

Parameters:

• Dest (BaseClass) – The destination object

• Add (bool) – Add members to class arrays or replace

Returns:

true if successful

Return type:

bool

Save(xml: any, ClassPtr: any, Extra: any = None)

Save class to the XML structure

Parameters:

• xml – The result

• ClassPtr – The pointer to the data, equals to this if class is directly castable

• Extra – Extra data pointer

Load(xml: any, ClassPtr: any, Extra: any = None) → bool

Load the class from the XML structure

Parameters:

• xml – The source XML

• ClassPtr – The pointer to the data, equals to this if class is directly castable

• Extra – Extra data pointer

Returns:

true if successful

Return type:

bool

FullCopy(SrcData: any, SrcDataExtra: any, Dest: BaseClass, DestData: any, DstDataExtra: any, C: any) → bool

Fast copy from one BaseClass to another. Names and types correspondence used to copy.

Parameters:

• SrcData – Data data pointer

• SrcDataExtra – Src extra

• Dest (BaseClass) – Destination class

• DestData – Destination data

• DstDataExtra – Destination extra

• C – copy context

Returns:

true if successful

Return type:

bool

SaveBin(Data: any, Extra: any, Out: any, ExDictionary: any, SkipList: any)

Save in binaly form. Use only for temporary storage in memory!!!

Parameters:

• Data – data pointer

• Extra – extra pointer

• Out – Output stream

• ExDictionary – Dictionary for enumerators

• SkipList – Skip list for enumerators

LoadBin(Data: any, Extra: any, In: any, ExDictionary: any)

Load the class from the memory. Use only for temporary storage in memory!!!

Parameters:

• Data – Pointer to the class data

• Extra – Extra data

• In – binary stream to read data from

• ExDictionary – Additional dictionary

GetAmountOfElementsInUI() → int

return amount of elements represented in UI

GetAmountOfElementsInXML() → int

return amount of elements taht will be stored in XML

pySerialize()

serialize and UI for python

pySerializeParentClass() → bool

get_class_name() → str

new_element() → BaseClass

construct pointer to class of the same type like this. Elements will not be copied into the new place

GetElement(res: any, idx: int, Ptr: any = None, Extra: any = None) → bool

The The function returns complete information about the member by it’s index. If you want to walk through all members use _EACH … _EACH_END loop.

Parameters:

• res – All data gathered there

• idx (int) – Index of the member

• Ptr – Pointer to data (if class is direcly castable it is equal to this, othervice it points to placement of data in memory). If NULL passed, this will be used

• Extra – Extra data, used for enumerators and sliders (mostly)

Returns:

return true if element exists and visible

Return type:

bool

GetElementByName(Name: str, Ptr: any, Extra: any, res: any, UI: bool = False, Serialize: bool = True) → bool

The function returns complete information about the member by it’s name.

Parameters:

• Name (str) – Name of the member

• Ptr – Data ptr

• Extra – Extra

• res – All data gathered there

Returns:

return true if element exists and visible

Return type:

bool

GetElementByNameAndType(Name: str, Type: str, Ptr: any, Extra: any, res: any, UI: bool = False, Serialize: bool = True) → bool

DeleteDefaultSubFields(xml: any, ClassPtr: any, Extra: any = None)

Short form saving. Fields that are unchanged in comparison to default will be skipped in XML.

ShouldSaveInShortForm() → bool

Return true if class should be saved in short form mandatory

ExpandWith(ElmName: str, base: any) → int

DelElement(Index: int) → bool

auto_cast(ptr: any) → BaseClass

ReadFromFile(Name: str, very_safe_with_backup: bool = False) → bool

Save the object to file or binary stream.

Example

|         MyClass C;
|         MyClass C1;

// to stream

MemoryBinStream BS;

C.ToBS(BS, true);

// copy from C to C1

C1.FromBS(BS); *

// to file

C.WriteToFile(“file.xml”);

C1.ReadFromFile(“file.xml”); *

// to string

cStr s;

C.ToStr(s);

C1.FromStr(s);

WriteToFile(Name: str) → bool

WriteToFileIfChanged(Name: str) → bool

ToStr(bs: any)

FromStr(bs: any)

see ToBS()

SetParent(Parent: BaseClass)

set parent recursively

SimplySetParent(Parent: BaseClass)

set parent directly to this, not affecting members

MayBeParent() → bool

CheckCompartabilityWith(TypeName: str, TypeSize: int) → bool

ProcessInEditor(Parent: BaseClass) → bool

RenderInScene(Parent: BaseClass) → bool

HandleKey(code: int) → bool

OnChangeMember(MembClass: BaseClass, MembPtr: any, MembExtra: any, MembName: str) → bool

BeforeChangeMember(MembClass: BaseClass, MembPtr: any, MembExtra: any, MembName: str)

GetElementLevel(EName: str) → int

OnCreateControlFromScratch(Context: any, Rect: any) → any

OnModifyControl(FieldName: str, W: any, Context: any)

CanBeDragged(MemberID: str, dx: int, dy: int) → bool

Use it for build a Drag & Drop element.

see CanAcceptDrag(), OnStartDrag(), OnEndDrag(), OnAcceptDrag()

CanAcceptDrag(MemberID: str) → bool

OnStartDrag(MemberID: str) → bool

OnEndDrag(MemberID: str) → bool

OnAcceptDrag(DraggedItemParent: BaseClass, DraggedMemberID: str, AcceptorMemberID: str, MyRect: any) → bool

UsePointerInHashCalculation() → bool

SkipHash() → bool

IsArray() → bool

GetCmdID() → str

SetParents()

SetParentsSafe()

set parents to this for all child members, each child will be tested for validity

static GetCurrentSaveFile() → str

CurrentSaveFile: str = None

If user triggers saving class to file, last filename stored there

UpdateClassMembersAndMask(recursive: bool)

SaveInShortForm: bool = False

static UI_definition() → bool

static Serialization() → bool

class cSItem

Bases: object

Name: str

Visible: bool

getName() → str

class cSBool(name: str, value: bool = False, visible: bool = True)

Bases: cSItem

static dynamic_cast(pObject: cSItem) → cSBool

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cSBool class or its descendant, and if so, returns the specified object, but of the cSBool type.

Value: bool

class cSColor(name: str, value: int = 0, visible: bool = True)

Bases: cSItem

static dynamic_cast(pObject: cSItem) → cSColor

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cSColor class or its descendant, and if so, returns the specified object, but of the cSColor type.

Value: int

class cSString(name: str, value: str, visible: bool = True)

Bases: cSItem

static dynamic_cast(pObject: cSItem) → cSString

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cSString class or its descendant, and if so, returns the specified object, but of the cSString type.

Value: str

class cSInt(name: str, value: int = 0, min: int = 0, max: int = 10, visible: bool = True)

Bases: cSItem

static dynamic_cast(pObject: cSItem) → cSInt

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cSInt class or its descendant, and if so, returns the specified object, but of the cSInt type.

Min: int

Max: int

Default: int

Value: int

class cSFloat(name: str, value: float = 0, min: float = 0, max: float = 10, visible: bool = True)

Bases: cSItem

static dynamic_cast(pObject: cSItem) → cSFloat

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cSFloat class or its descendant, and if so, returns the specified object, but of the cSFloat type.

Min: float

Max: float

Value: float

Default: float

class cREG

Bases: object

static modalMessageBox(text: str, Caption: str, Buttons: str, Flags: int, Class: BaseClass) → int

static reg_class(class_ref: BaseClass)

static function_call(ui_cmd: str)

static checkbox(cb: cSBool)

static delimiter()

static droplist(field: cSInt, enum_id: str)

REG_DROPLIST(fieldID, name, EnumID) adds the droplist to UI, list into XML. The referred variable should be int

hideinitializer

Example:

::

class MyClass : public BaseClass{

int x1;

int x2;

SERIALIZE(){ …

//create enumerator just now and use immediately

REG_DROPLIST(x1, “droplist1”, “Item1|Item2|Item3”);

//Other option is to create Enumerator right there or somewhere in code

_MAKE_ONCE{//use it to avoid multiple call of code

Enumerator* E = ENUM.Get(“MYENUMERATOR”);

if(E->GetAmount() == 0){

E->Add(“SomeItem1”,Value1);

E->Add(“SomeItem1”,Value2); …

}

}

REG_DROPLIST(x2, “droplist2”, “MYENUMERATOR”);

//You may define Enumerator just in one line

MAKE_ENUMERATOR(“MYENUMERATOR2”,”Item1|Item2|Item3”);

REG_DROPLIST(x2, “droplist2”, “MYENUMERATOR2”); …

}

};

static make_enumerator(enum_id: str, content: str)

Make Enumerator in just one line

hideinitializer

|         MAKE_ENUMERATOR("MYENUMERATOR2","Item1|Item2|Item3");

….somewhere…

REG_DROPLIST(x2, “droplist2”, “MYENUMERATOR2”);

Parameters:

content (str) – List of items “Item1,Item2,….”

static ui_layout(layout: str)

UI_LAYOUT(str) splits ui elements to several columns with proportional or fixed width

hideinitializer

UI_LAYOUT may use two additional keywords: TOP and BOTTOM. TOP moves controls to the tor of the window frame (header -like)

BOTTOM moves elements to the bottom of the frame, like toolset buttons. It is recommended to use ICON_BUTTON/3/4 for bottom toolset.

Example:

|          class MyClass : public BaseClass{

void button();

void long_button();

void X();

SERIALIZE(){ …

//places next 3 controls in one line: [button][long_button][X], length of [button] is twice less than [long_button], [X] has fixed width 32

UI_LAYOUT(“1 2 [32]”);

CLASS_METHOD_CALL(button);//[button]

CLASS_METHOD_CALL(long_button);//[long_button]

CLASS_METHOD_CALL(X);//[X] …

}

};

static slider_int(var: cSInt)

SLIDER(var,name,minvalue,maxvalue) to add integer/float slider in UI. Only float and int supported

hideinitializer

Example:

::

class MyClass : public BaseClass{ *

int x;

float y; *

SERIALIZE(){ …

SLIDER(x,”X”,0,10);

SLIDER(y,”Y”,0.0,10.0); …

}

};

Parameters:

var (cSInt) – variable ref

static slider_float(var: cSFloat)

static file_path(var: cSString, file_mask: str)

use FILEPATH(str, name, mask) to add file selection control in UI. Only cStr supported

hideinitializer

Example:

::

class MyClass : public BaseClass{

cStr path;

SERIALIZE(){

FILEPATH(path,”FilePath”,”save:.tif;.tiff;*.exr;*.tga;*.bmp;*.png”);

}

};

static vector2D(vec: cVec2)

register cVec2

static Rect(rect: any)

register Rct

static vector3D(vec: cVec3)

register Vector3D

static vector4D(vec: cVec4)

register Vector4D

static icon(path: str)

Insert icon if control supports.

static checkbox_group(group_name: str)

specify group for checkbox.

static hotkey(combo: str)

assign default hotkey to the UI element, like HOTKEY(“CTRL E”)

static left_align()

force left-align to the control

static element_color(color: str)

the element color

static font_color(color: str)

the font color

static reg_opt(opt: str)

static reg_coord(x: float, y: float, z: float)

Place 3 lines of code in correspondence with current coordinate system - Y-up or Z-up

hideinitializer

Parameters:

• x (float) – X - related item

• y (float) – Y - related item

• z – Z - related item

class cAction

Bases: object

Enabled: bool

Implementation: any

cSlot Before;

ExecImplementation() → bool

Run() → bool

HasEnabledChild() → bool

cAction* GetChild(int child_id);

class cExAction(name: str, extension: str, message: str, hint: str = '')

Bases: object

class LinkedObjectBaseType

Bases: object

static registerObjectType(objectType: LinkedObjectBaseType)

TopologyLocked: bool

SetTopologyLocked(newValue: bool)

OnModifyTreeItem(Name: str, BW: any)

actions: list[cExAction]

addAction(extension: str, name: str, message: str = '', hint: str = '')

clearActions()

objectType: str

IconTexture: int

extension for file

setIconTexture(textureID: int)

setObjectType(object_type: str)

class LinkedObject

Bases: BaseClass

static dynamic_cast(pObject: BaseClass) → LinkedObject

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a LinkedObject class or its descendant, and if so, returns the specified object, but of the LinkedObject type.

getType() → LinkedObjectBaseType

idx: int

Scaling: float

TopologyLocked: bool

objectPath: any

class cColorSelectorInterface

Bases: object

ShowAlpha: bool

Red: float

Green: float

Blue: float

Alpha: float

ShowModal() → bool

IsActive() → bool

class pyRequirement

Bases: object

initialized: bool = True

module_name: str

module_version: str

installing() → bool

checkIfInstalled() → bool

installing_name: str = ''

installing_id: int = -1

static install_all()

static Check(name: str, install: bool = True, show_progress: bool = False, ask: bool = False, on_finish: any = None) → pyRequirement

static GetRequirementInfo(name: str) → pyRequirement

static EnsurePipInstalled()

class cExtension

Bases: object

extensionHandler: any

static Message(extension_name: str, message: str) → bool

static ProcessID() → int

static DebugPort() → int

static getCoatInstallForder() → str

refresh_menu() → bool

add_menu_item(MenuPath: str, MenuItem: str, inRoom: str = '', inSection: str = '', Command: str = '') → bool

onStop()

onStart()

onRestart()

menu_item(item_name: str, on_click: any) → bool

getSourcePath() → str

SourcePaoth

onMessage(message: str)

Call if another module sent message to this extension using cExtension.Message

onExtendMenu()

insert some menu items to main menu

onBuildMainMenu()

on build the main menu

onStartup()

Call on startup, right before tools initialisation.

afterInit()

Call it after tools, graphics and shaders initialisation.

preprocess()

Call it once per frame, before tools processing.

prerender()

Call it once per frame, before the rendering stage.

postprocess()

Call it once per frame, after tools processing.

postrender()

Call it once per frame, after the rendering stage.

afterUI()

Call it once per frame, after the ui rendering, before the topmost elements

thumbnail()

Call it once per frame to draw thumbnails.

afterSettings()

Call it once after settings loading.

onNew()

Call it as soon as user starts new scene.

onKey()

Call it as soon as user pressed the key, get the key value from Widgets::lastKey. Set it to 0 if the key captured and des not need to be propagated anymore.

onDropFile()

Call if file dropped using drag&drop, filename is in Widgets::LastDroppedFile. Set it empty if you acquired the file.

onChangeTool()

called when the current tool changes

onChangeRoom()

called when the current room changes

onUndo()

called when the undo triggered

onRedo()

called when the redo triggered

onSaveScene()

called before the saving the scene

onExit()

called before the exit

static begin_work_in_bg() → int

static end_work_in_bg() → int

class cExtensionHandler

Bases: BaseClass

static dynamic_cast(pObject: BaseClass) → cExtensionHandler

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a cExtensionHandler class or its descendant, and if so, returns the specified object, but of the cExtensionHandler type.

name: cStr

uiname: cStr

path: cStr

mainModule: any

onStartUpModule: any

Loaded: bool

NeedRestartApp: bool

extension: cExtension

Started: bool

Active: bool

AutoStart: bool

StartAfterInstalls: bool

Error: bool

ErrorMessage: cStr

dependencies: any

Start()

Stop()

Restart()

OnState(state: cStr)

class ExtensionManager

Bases: BaseClass

static dynamic_cast(pObject: BaseClass) → ExtensionManager

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a ExtensionManager class or its descendant, and if so, returns the specified object, but of the ExtensionManager type.

ProcessID: int = 31560

DebugPort: int = 6449

static AutoReloadModules() → bool

static OnExtensionState(state: cStr)

static SetExtensionManager(extensionManager: ExtensionManager)

MainColorSelector: cColorSelectorInterface = <cModules.QTColorSelector.QTColorSelector.QTColorSelector object>

NeedRefreshPyInstalledModuleList: bool = False

AddInstalledPyModule(module_name: str)

ClearInstalledPyModuleList()

static CommandToPy(command: str) → str

Command(command: str) → bool

static ExecScriptFromCPPStatic(script: str) → bool

ExecScript(script: str) → bool

ExecByIdx(action_idx: int) → bool

Expression(source: str) → str

OnImport(module: str)

ImportModule(module: str) → bool

Run(file_path: str)

RunPy(file_path: str) → bool

static RunPyFromCPPStatic(file_path: str) → bool

LoadExtensions(rootFolderPath: cStr)

Refresh()

OnProcess()

RefreshInstalledList()

static currentDateTime() → str

static Init()

ReloadChangedModules()

static SetupVSCodeProject(aProjectFolder: cStr, aModulesInit: bool, aLibRoot: bool)

static StringFromFile(aFileName: cStr) → cStr

static StringToFile(aSource: cStr, aFileName: cStr)

FindExtension(extName: cStr) → cExtensionHandler

class ExtPhotogrammetryEngine

Bases: object

Registred: bool

hasHowToInstall: bool

hasAutoInstall: bool

hasSetPathToEngine: bool

engineName() → str

Register(setDefault: bool = False) → bool

NeedAutoReconstruction() → bool

ShotsTo3D()

ImportProject()

BakeUVTextures()

VideoTo3D()

HowToInstall()

AutoInstall()

SetPathToEngine()

CheckIfInstalled() → bool